/* ==========================================
 * JGraphT : a free Java graph-theory library
 * ==========================================
 *
 * Project Info:  http://jgrapht.sourceforge.net/
 * Project Creator:  Barak Naveh (http://sourceforge.net/users/barak_naveh)
 *
 * (C) Copyright 2003-2006, by Barak Naveh and Contributors.
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
 */
/* ------------------
 * VisioExporter.java
 * ------------------
 * (C) Copyright 2003-2006, by Avner Linder and Contributors.
 *
 * Original Author:  Avner Linder
 * Contributor(s):   Barak Naveh
 *
 * $Id: VisioExporter.java,v 1.2 2007/05/22 15:52:59 kjellw Exp $
 *
 * Changes
 * -------
 * 27-May-2004 : Initial Version (AL);
 *
 */
package org.jgrapht.ext;

import java.io.*;

import java.util.*;

import org.jgrapht.*;

/**
 * Exports a graph to a csv format that can be imported into MS Visio.
 * 
 * <p>
 * <b>Tip:</b> By default, the exported graph doesn't show link directions. To
 * show link directions:<br>
 * 
 * <ol>
 * <li>Select All (Ctrl-A)</li>
 * <li>Right Click the selected items</li>
 * <li>Format/Line...</li>
 * <li>Line ends: End: (choose an arrow)</li>
 * </ol>
 * </p>
 * 
 * @author Avner Linder
 */
public class VisioExporter<V, E> {
	// ~ Instance fields
	// --------------------------------------------------------

	private VertexNameProvider<V> vertexNameProvider;

	// ~ Constructors
	// -----------------------------------------------------------

	/**
	 * Creates a new VisioExporter object with the specified naming policy.
	 * 
	 * @param vertexNameProvider
	 *            the vertex name provider to be used for naming the Visio
	 *            shapes.
	 */
	public VisioExporter(VertexNameProvider<V> vertexNameProvider) {
		this.vertexNameProvider = vertexNameProvider;
	}

	/**
	 * Creates a new VisioExporter object.
	 */
	public VisioExporter() {
		this(new StringNameProvider<V>());
	}

	// ~ Methods
	// ----------------------------------------------------------------

	/**
	 * Exports the specified graph into a Visio csv file format.
	 * 
	 * @param output
	 *            the print stream to which the graph to be exported.
	 * @param g
	 *            the graph to be exported.
	 */
	public void export(OutputStream output, Graph<V, E> g) {
		PrintStream out = new PrintStream(output);

		for (Iterator<V> i = g.vertexSet().iterator(); i.hasNext();) {
			exportVertex(out, i.next());
		}

		for (Iterator<E> i = g.edgeSet().iterator(); i.hasNext();) {
			exportEdge(out, i.next(), g);
		}

		out.flush();
	}

	private void exportEdge(PrintStream out, E edge, Graph<V, E> g) {
		String sourceName = vertexNameProvider.getVertexName(g
				.getEdgeSource(edge));
		String targetName = vertexNameProvider.getVertexName(g
				.getEdgeTarget(edge));

		out.print("Link,");

		// create unique ShapeId for link
		out.print(sourceName);
		out.print("-->");
		out.print(targetName);

		// MasterName and Text fields left blank
		out.print(",,,");
		out.print(sourceName);
		out.print(",");
		out.print(targetName);
		out.print("\n");
	}

	private void exportVertex(PrintStream out, V vertex) {
		String name = vertexNameProvider.getVertexName(vertex);

		out.print("Shape,");
		out.print(name);
		out.print(",,"); // MasterName field left empty
		out.print(name);
		out.print("\n");
	}
}

// End $file.name$
